Skip to content

Fix Squiz.Commenting.FunctionComment.InvalidNoReturn false positive when return type is never #3717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 14, 2023
Merged

Fix Squiz.Commenting.FunctionComment.InvalidNoReturn false positive when return type is never #3717

merged 1 commit into from
Jul 14, 2023

Conversation

@axlon
Copy link
Contributor

@axlon axlon commented Nov 21, 2022

The Squiz.Commenting.FunctionComment.InvalidNoReturn causes false positives when it encounters the never return type.

Tested this locally with:

<rule ref="Squiz.Commenting.FunctionComment.InvalidNoReturn"/>
/**
 * @return never
 */
private function foo()
{
    throw new \RuntimeException('This method never returns');
}

@jrfnl
Copy link
Contributor

jrfnl commented May 4, 2023

@axlon Thanks for this PR. Could you please add some tests to cover this change ? Let me know if you have questions on how to do this.

@fredden fredden mentioned this pull request May 7, 2023
Closed
@axlon
Copy link
Contributor Author

axlon commented May 8, 2023

@jrfnl I managed to add the test, please let me know if anything needs changing 👍

jrfnl
jrfnl approved these changes May 18, 2023
View reviewed changes
Copy link
Contributor

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@axlon Thanks for adding that test. All looks good!

jrfnl
jrfnl requested changes May 18, 2023
View reviewed changes
Copy link
Contributor

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@axlon I'm sorry, I spoke too soon. Looks like the tests are failing now. Could you please have a look ?

@axlon
Copy link
Contributor Author

axlon commented May 30, 2023 •
edited
Loading

@jrfnl I made the changes you requested, hope everything is ok, could you start the workflow for tests? Currently don't have a PHP 7.0 environment available to test on.

EDIT: one thing I changed from before is that an error should now be emitted if a function has a documented return type of never but has a return statement (which already happened for void functions). I couldn't figure out how write a test for this, could you point me in the right direction?

-------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------
 182 | ERROR | Function return type is never, but function contains return statement
-------------------------------------------------------------------------------------------

jrfnl
jrfnl requested changes May 31, 2023
View reviewed changes
Copy link
Contributor

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one thing I changed from before is that an error should now be emitted if a function has a documented return type of never but has a return statement (which already happened for void functions). I couldn't figure out how write a test for this, could you point me in the right direction?

-------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------
 182 | ERROR | Function return type is never, but function contains return statement
-------------------------------------------------------------------------------------------

This change evolves this PR from a bug fix to an enhancement and will definitely need more tests.

It also looks like this new part is unfinished as it doesn't seem to work the way it should ?

Could you please have another look at this ?

@axlon
Copy link
Contributor Author

axlon commented May 31, 2023

@jrfnl

This change evolves this PR from a bug fix to an enhancement and will definitely need more tests.

I think you are right, it definitely became a lot larger than I intended and I will need to immerse myself a bit more into writing tests for this library. I think I will revert this to only being a bugfix for now, and will follow up with a full fledged PR later. 👍

@axlon
Copy link
Contributor Author

axlon commented Jun 8, 2023

@jrfnl I think the PR is ready for review now

@jrfnl
Copy link
Contributor

jrfnl commented Jul 11, 2023

@axlon Would you mind rebasing this PR (and possibly squashing the commits) to get it past the merge conflict ?

@axlon
Copy link
Contributor Author

axlon commented Jul 13, 2023

@jrfnl Done!

jrfnl
jrfnl approved these changes Jul 14, 2023
View reviewed changes
Copy link
Contributor

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @axlon ! The isolated bug fix, which this PR is now (again), looks good.

Just checking: do you intend to submit a PR for the follow-up which was discussed in the comments as well ?

@jrfnl jrfnl merged commit 974c362 into squizlabs:master Jul 14, 2023
jrfnl added a commit that referenced this pull request Jul 14, 2023
@jrfnl
Changelog for #3717
b8d7e94
@jrfnl jrfnl added this to the 3.8.0 milestone Jul 14, 2023
@axlon axlon deleted the invalid-return-never branch July 14, 2023 07:13
@axlon
Copy link
Contributor Author

axlon commented Jul 14, 2023

@jrfnl Thanks! Yes, I still intend to create a followup PR whenever I find the time, but if someone else picks it up before me that is fine by me as well

@jrfnl
Copy link
Contributor

jrfnl commented Dec 8, 2023

FYI: this fix is included in today's PHP_CodeSniffer 3.8.0 release.

As per #3932, development on PHP_CodeSniffer will continue in the PHPCSStandards/PHP_CodeSniffer repository. If you want to stay informed, you may want to start "watching" that repo (or watching releases from that repo).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jrfnl jrfnl jrfnl approved these changes

Assignees

No one assigned

Labels

Standard: Squiz Type: enhancement

Projects

None yet

Milestone

3.8.0

Development

Successfully merging this pull request may close these issues.

3 participants

@axlon @jrfnl @gsherwood